Repository navigation
Conversation
With a progress or state callback configured and the frequency left at 0 (or set negative), the reporting loop waits on time.After(0) and posts to the callback as fast as it can.
ProgressReportFrequency and StateReportFrequency now default to 60000ms like other optional settings, and ValidateConfig rejects values below 100ms when the matching callback is configured. Fixes #214.
shivnagarajan
approved these changes
Oct 22, 2026
shivnagarajan
left a comment
shivnagarajan
left a comment
Contributor
There was a problem hiding this comment.
Just a few comments. Nothing super critical, but just some minor adjustments suggested.
| c.CutoverRetryWaitSeconds = 1 | ||
| } | ||
|
|
||
| if c.ProgressReportFrequency == 0 { |
Contributor
There was a problem hiding this comment.
so this fix is in ValidateConfig, but things like ferry.go/Run does not call ValidateConfig
Can we also add support there to set the minimum
| - Finish replayed GTID transactions before stopping at cutover, even when their GTIDs were already streamed before a reconnect. | ||
| - Exclude the current GTID from serialized resume checkpoints during reconnect replay, preserving other committed GTIDs. Stop streaming on invalid GTID identities before delivering further rows. | ||
| - Publish binlog stop requests atomically after recording the stop coordinate, including reads from the control server. | ||
| - Default `ProgressReportFrequency` and `StateReportFrequency` to 60000 ms, and reject values below 100 ms when the matching callback is set. An unset, zero or negative frequency used to make Ghostferry post to the callback in a tight loop ([#214](https://github.com/Shopify/ghostferry/issues/214)). |
Contributor
There was a problem hiding this comment.
am curious whether this should be under Changed instead of Fixed. With this update, values < 100 will be rejected, but were accepted before.
| if c.ProgressReportFrequency == 0 { | ||
| c.ProgressReportFrequency = defaultReportFrequencyMs | ||
| } | ||
| if c.ProgressCallback.URI != "" && c.ProgressReportFrequency < minReportFrequencyMs { |
Contributor
There was a problem hiding this comment.
it is a bit strange that 0 is handled differently from values < minReportFrequencyMs (100)
| this.Require().Equal(60000, this.config.StateReportFrequency) | ||
| } | ||
|
|
||
| func (this *ConfigTestSuite) TestReportFrequenciesBelowMinimumAreRejected() { |
Contributor
There was a problem hiding this comment.
Not critical but
- We dont actually test that 99 passes and 100 fails. (i.e. a boundary condition).
- We dont test that 0 is replaced with defaultReportFrequencyMs
- We dont test that valid values (500) are passed through
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #214. Supersedes #215.
Problem
ProgressReportFrequencyandStateReportFrequencyhave no default and no validation. The reporting loops wait ontime.After(time.Duration(freq) * time.Millisecond), so with a callback URI set and the frequency left at 0 (or set negative) the loop fires immediately, forever. Each iteration builds a fullProgress(or serializes the whole state) and POSTs it synchronously.Smoke run with the real
ghostferry-copydbbinary on a 3-row table,ProgressCallbackset and no frequency:mainProgressReportFrequency: 500ProgressReportFrequency: -1failed to validate config: ProgressReportFrequency must be at least 100 milliseconds, got -1Fix
In
Config.ValidateConfig:0defaults to 60000 ms, matching how other optional numeric settings are defaulted (BinlogEventBatchSize,DBReadRetries, ...).#215 clamped to a 1-minute minimum inside the loops instead. That would silently override the 500 ms the integration tests use and the 1500 ms the benchmark uses. Rejecting at validation reports the misconfiguration at startup instead.
All in-repo entry points (copydb, sharding, integration ferry, test helpers) call
ValidateConfig.Repro
The first commit adds only the tests:
TestConfig/TestReportFrequenciesDefaultWhenCallbacksAreSet: before the fix the frequency stayed0.TestConfig/TestReportFrequenciesBelowMinimumAreRejected: before the fix there was no error for-1or50.Verification (local, MySQL 8.0.32)
go test ./copydb/test ./sharding/testandgo test ./test/go -run 'TestConfig|TestLogger': pass.test/integration/callbacks_test.rb: 3 tests, 0 failures.mainand this branch.